home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 3: Developer Tools / Linux Cubed Series 3 - Developer Tools.iso / devel / lang / lisp / gcl-1.000 / gcl-1 / gcl-1.0 / README < prev   
Encoding:
Text File  |  1994-05-08  |  7.9 KB  |  264 lines
  1. Description of GCL (GNU Common Lisp) system.
  2.  
  3. OVERVIEW:
  4.  
  5. The GCL system contains C and lisp source files to build a common lisp
  6. sytem.  The original KCL system was written by Taiichi Yuasa and
  7. Masami Hagiya in 1984.  The AKCL system work was begun in 1987 by
  8. William Schelter and continued through 1994.  A number of people
  9. have contributed ports and pieces.  The file doc/contributors lists
  10. some of these.  In 1994 AKCL was released as GCL (GNU Common Lisp) the
  11. GNU public library license.  Version akcl-1-624 was the last version
  12. made under the old license and using the old file change mechanism.
  13. This readme only applies to versions gcl.1.0 and later.  The GNU library
  14. license does allow redistribution of executables containing GCL as
  15. well as users proprietary code, but such redistribution must be
  16. accompanied by sufficient material (eg .o files) to allow recipients
  17. to rebuild an executable, after possibly modifying GCL.  See the GNU
  18. file COPYING.LIB-2.0 for a full description of your right to copy this
  19. software.
  20.  
  21.  
  22.  
  23. OBTAINING SOURCES:
  24. -----------------
  25.  
  26. * There are source files on math.utexas.edu:pub/gcl/gcl.x.x.tgz You
  27. probably want the highest XX version number.  For example gcl.1.0.tgz
  28. would allow you to build the version 1.0 of GCL.  In the following
  29. this compressed tar file is simply referred to as gcl.tgz.  An
  30. alternate source for these files is ftp.cli.com:pub/gcl/gcl-XX.tgz If you
  31. do not have gzip it is available in the directory
  32. /anyonymous@prep.ai.mit.edu:/u2/emacs .
  33. GCL will also be available on prep.ai.mit.edu
  34.                    
  35.  
  36. MAKING THE SYSTEM:
  37. ==================
  38. To make the whole system, if you have obtained gcl.tgz. 
  39.  
  40. UNCOMPRESS and UNTAR the SOURCES:
  41. --------------------------------
  42.  
  43. Change to a directory in which you wish to put gcl, eg /usr/local,
  44. which we shall call PREFIX-DIR.
  45. Copy the file gcl.tgz to the PREFIX-DIR.
  46.  
  47. % gzip -dc gcl.tgz | tar  xvf -
  48.  
  49. This will create the directory ${PREFIX-DIR}/gcl-1.xxx with
  50. all the sources in it
  51.  
  52.  
  53.       
  54. ADD MACHINE DEFINITIONS TO MAKEFILES:
  55. ------------------------------------
  56.  
  57. Determine the NAME of your machine by looking in the MACHINES file (eg
  58. sun3-os4).
  59.  
  60.         % cd gcl-1.xxx 
  61.     % add-defs sun3-os4 
  62.  
  63.     You should finally be ready to go!
  64.  
  65. RUNNING MAKE:
  66. ------------
  67.  
  68.     % make
  69.  
  70. The make should continue without error.   There may be occasional
  71. warnings from the C compiler, but all files should compile successfully
  72. producing .o files.
  73.  
  74. At the end you should see a message at the end "Make of GCL xxx
  75. completed", where xxx stands for the version number.
  76.  
  77. TRY IT OUT:
  78. ----------
  79.  
  80. When it has finally finished you may invoke GCL by using
  81.  
  82. % xbin/gcl
  83. GCL (GNU Common Lisp)  Version(1.0)  Apr 21 00:52:31 CDT 1994
  84. Contains Enhancements by W. Schelter
  85. >(+ 2 3)
  86.  
  87. >5
  88.  
  89.  
  90. COPY THE COMMAND SCRIPT:
  91. -----------------------
  92.  
  93.     * You should copy xbin/kcl to /usr/local/bin or some place on users
  94.     search paths.   This is so that users may conveniently invoke the saved
  95.     image with a first arg equal to the directory where the image resides.
  96.     (some things like faslink, autoload,.. need to know the system directory).
  97.  
  98.  
  99. INSTALLING:
  100. ----------
  101.     To install under /usr/local do
  102.  
  103.         make install
  104.  
  105.     To specify an alternate directory such as /lusr
  106.        do 
  107.  
  108.     make install PREFIX_DIR=/lusr
  109.  
  110.     The default installation puts a full executable in
  111.  
  112.         /usr/local/lib/gcl-version/unixport/saved_gcl
  113.  
  114.     and some doc in
  115.           
  116.           /usr/local/lib/gcl-version/doc/
  117.  
  118.     and some autoloading files in
  119.  
  120.       /usr/local/lib/gcl-version/lsp
  121.  
  122.         and a shell script in /usr/local/lib/gcl-version/xbin/gcl
  123.     This script is also copied to
  124.  
  125.     /usr/local/bin
  126.  
  127. FUTURE DIRECTIONS
  128. (and how you may be able to help)   Volunteers should contact
  129. William Schelter (wfs@math.utexas.edu)
  130.  
  131. a) Upgrading to comply with the forthcoming ANSI standard.   Work 
  132. needs to be done.   
  133.  
  134. b) Need work on providing a high level window interface.   One possible
  135. way would be a good connection with TCL/TK.   Another would be to go
  136. in the direction of CLIM.   
  137.  
  138. A new compiler has been written, which is closer to the ANSI standard
  139. and provides some other benefits.   It will be in a future release.
  140. We will need people willing to beta test and isolate any bugs.
  141.  
  142. DOCUMENTATION:
  143. ==============
  144.    If you use gnu emacs, a convenient method for viewing documentation
  145. of common lisp functions (or functions in an extended system), is
  146. provided by the doc/find-doc.el file.  This will be installed when you
  147. do make in the doc directory.  Adding the following to your .emacs
  148. file will allow you to use C-h d to find documentation.
  149.  
  150. (autoload 'find-doc "find-doc" nil t)
  151. (global-set-key "d" 'find-doc)
  152. (visit-doc-file "/usr/local/lib/gcl/doc/DOC")
  153.  
  154. See the file find-doc.el for more information.
  155. Otherwise you may use the describe command inside lisp.
  156. For example (describe 'print) will print out information about
  157. print.   You may also peruse the file doc/DOC.
  158.  
  159.  
  160. TROUBLE SHOOTING (some common problems reported):
  161. ----------------   
  162.  
  163. 1) Did you extract the files with the original write dates--make
  164. depends heavily on this?
  165.  
  166. 2) Did you use -O on a compiler which puts out bad code?  Any time you
  167. change the settings or use a new c compiler this is a tricky point.
  168.  
  169. 3) A sample transcript from a correct make is included under
  170. doc/sample-make.  If yours compiles less often or does things
  171. differently, something is wrong, probably with dates or the clock on
  172. the server or something.
  173.  
  174. 4) If you can't save an image, try doing so on the file server rather
  175. than a client.
  176.  
  177. 5) Doing the make on a client with the main files on a server, has
  178. sometimes caused random breakage.  The large temp files used by the C
  179. compiler seem to sometimes get transferred incorrectly.  Solution: use
  180. the server for the compile.
  181.  
  182. 6) Did you make changes in the .defs or .h files, other than just
  183. commenting out a CC=gcc line?
  184.  
  185. 7) Did you read the recommendations in the XXXX.defs file on what
  186. C compiler versions work?
  187.  
  188.  
  189. CHANGING THINGS: MAYBE EDIT TWO FILES:
  190. --------------------
  191.  
  192. Normally you should not need to edit ANY files.  There may be some
  193. parameter sizes you wish to change or if you don't have gcc where
  194. we have made that the default, then see CC below.
  195.  
  196.  
  197. EDIT the appropriate h/NAME.defs file.   These are definitions to
  198. be included in the various makefiles.
  199.  
  200. For example if the `NAME' of your machine is sun3-os4.
  201.  
  202. % emacs h/sun3-os4.defs
  203.  
  204.    * CC: set C compiler options.  For example, if you are using the GNU
  205.      C compiler:
  206.  
  207.      CC = gcc -msoft-float -DVOL=volatile -I$(GCLDIR)/o
  208.  
  209.          Or, if you are using the conventional UNIX C compiler:
  210.  
  211.      CC = cc -DVOL= -I. -I$(GCLDIR)/o
  212.      
  213.    * ODIR_DEBUG:
  214.      
  215.      ODIR_DEBUG= -g
  216.  
  217.      If you want files in the main c source compiled with debugging
  218.      information.   Note this is incompatible with OFLAGS= -O on
  219.      some compilers.   Size will be smaller without -g, but you
  220.      are then helpless in the face of problems.
  221.      
  222.    * INITFORM: The normal thing is to just have the one form
  223.      required for fast loading.
  224.  
  225.     INITFORM=(si::build-symbol-table)
  226.  
  227.  
  228. -----------
  229.  
  230. EDIT the file h/NAME.h  (eg h/sun3-os4.h)
  231.  
  232. (Actually you probably don't need to change it)
  233.  
  234. This file will be included by virtually every compilation of C
  235. files, except the translated C produced by kcl.
  236.  
  237. % emacs h/sun3-os4.h
  238.  
  239.       if you wish to change a parameter such as MAXPAGE 16384 established
  240.       in bsd.h (ie. number of 2000 byte pages you want as your absolute max
  241.       swap space).   MAXPAGE must be a power of 2.
  242.  
  243.       #undef MAXPAGE
  244.       #define MAXPAGE (2 * 16384)
  245.  
  246.       You may similarly redefine VSSIZE the maximum size for the value
  247.       stack (running very deep recursion interpreted may well require this).
  248.  
  249.  
  250.  
  251. DISCLAIMER:
  252. ----------
  253.  
  254. W. Schelter, the University of Texas, and other parties provide this
  255. program on an "as is" basis without warranty of any kind, either
  256. expressed or implied, including, but not limited to, the implied
  257. warranties of merchantability and fitness for a particular purpose.
  258.  
  259.  
  260. Bill Schelter 
  261. wfs@math.utexas.edu
  262.  
  263. See the file doc/contributors for a partial list of people who have
  264. made helpful contributions to ports etc.